added pagination to listJobs endpoint #96
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chuckwondo
requested changes
Jul 11, 2024
maap/maap.py
Outdated
Comment on lines
262
to
276
|
|
||
| query_params = [] | ||
| if page_size is not None: | ||
| query_params.append(f"page_size={page_size}") | ||
| if offset is not None: | ||
| query_params.append(f"offset={offset}") | ||
|
|
||
| query_string = "&".join(query_params) | ||
|
|
||
| if query_string: | ||
| endpoint = endpoints.DPS_JOB_LIST + "?" + query_string | ||
| url = os.path.join(self.config.dps_job, username, endpoint) | ||
| else: | ||
| url = os.path.join(self.config.dps_job, username, endpoints.DPS_JOB_LIST) | ||
|
|
There was a problem hiding this comment.
You should not be manually adding query params to a URL. The requests library properly deals with them, including doing proper encoding. Simply construct a params dict and pass it as an additional named argument to requests.get:
Suggested change
| query_params = [] | |
| if page_size is not None: | |
| query_params.append(f"page_size={page_size}") | |
| if offset is not None: | |
| query_params.append(f"offset={offset}") | |
| query_string = "&".join(query_params) | |
| if query_string: | |
| endpoint = endpoints.DPS_JOB_LIST + "?" + query_string | |
| url = os.path.join(self.config.dps_job, username, endpoint) | |
| else: | |
| url = os.path.join(self.config.dps_job, username, endpoints.DPS_JOB_LIST) | |
| url = os.path.join(self.config.dps_job, username, endpoints.DPS_JOB_LIST) | |
| params = {k: v for k, v in (("page_size", page_size), ("offset", offset)) if v} | |
And then, change the call to requests.get that follows, to this:
response = requests.get(
url=url,
headers=headers,
params=params,
)
chuckwondo
reviewed
Jul 11, 2024
There was a problem hiding this comment.
Any chance of filling in a unit test? https://github.com/MAAP-Project/maap-py/blob/master/test/test_DPS.py#L55-L56
|
I created #97 to implement the unit test method stubs. It looks like there's more work needed to get this into a functional state as well (removing maap.cfg reference and mocking the API), which falls out of scope of this ticket. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added optional pagination parameters to listJobs endpoint. Sample maap-py calls and their corresponding MAAP API requests:
r = maap.listJobs("mlucas") : https://api.dit.maap-project.org/api/dps/job/mlucas/listr = maap.listJobs("mlucas", 20, 10) : https://api.dit.maap-project.org/api/dps/job/mlucas/list?page_size=20&offset=10Work needed for this ticket